<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>JPackage xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/com/seventytwomiles/architecturerules/domain/JPackage.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * Copyright 2007 the original author or authors.</em>
<a name="3" href="#3">3</a>   <em> *</em>
<a name="4" href="#4">4</a>   <em> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> *         <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em> *</em>
<a name="10" href="#10">10</a>  <em> * For more information visit</em>
<a name="11" href="#11">11</a>  <em> *         <a href="http://72miles.com" target="alexandria_uri">http://72miles.com</a> and</em>
<a name="12" href="#12">12</a>  <em> *         <a href="http://architecturerules.googlecode.com/svn/docs/index.html" target="alexandria_uri">http://architecturerules.googlecode.com/svn/docs/index.html</a></em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> com.seventytwomiles.architecturerules.domain;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="19" href="#19">19</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>import</strong> <strong>static</strong> java.lang.String.format;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.regex.Matcher;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.regex.Pattern;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em> * &lt;p>A java package. This class wraps the java package to give it</em>
<a name="29" href="#29">29</a>  <em> * functionality, such as the ability to check and see if it matches another</em>
<a name="30" href="#30">30</a>  <em> * package.&lt;/p></em>
<a name="31" href="#31">31</a>  <em> *</em>
<a name="32" href="#32">32</a>  <em> * @author mikenereson</em>
<a name="33" href="#33">33</a>  <em> */</em>
<a name="34" href="#34">34</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a> {
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log
<a name="38" href="#38">38</a>              = LogFactory.getLog(JPackage.<strong>class</strong>);
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>      <em>/**<em>*</em></em>
<a name="41" href="#41">41</a>  <em>     * &lt;p>All of the symbols or characters that represent a wildcard.&lt;/p></em>
<a name="42" href="#42">42</a>  <em>     */</em>
<a name="43" href="#43">43</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>char</strong>[] WILDCHARS = <strong>new</strong> <strong>char</strong>[]{'*'};
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em>     * &lt;p>period separated path to package such as &lt;samp>com.seventeytwomiles.architecturerules.domain&lt;/samp>.&lt;/p></em>
<a name="47" href="#47">47</a>  <em>     *</em>
<a name="48" href="#48">48</a>  <em>     * @parameter path String</em>
<a name="49" href="#49">49</a>  <em>     */</em>
<a name="50" href="#50">50</a>      <strong>private</strong> String path;
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em>/**<em>*</em></em>
<a name="54" href="#54">54</a>  <em>     * &lt;p>Constructs a new &lt;code>JPackage&lt;/code>&lt;/p></em>
<a name="55" href="#55">55</a>  <em>     */</em>
<a name="56" href="#56">56</a>      <strong>public</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a>() {
<a name="57" href="#57">57</a>      }
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em>/**<em>*</em></em>
<a name="61" href="#61">61</a>  <em>     * &lt;p>Constructs a new &lt;code>JPackage&lt;/code> with the given</em>
<a name="62" href="#62">62</a>  <em>     * &lt;tt>path&lt;/tt>&lt;/p></em>
<a name="63" href="#63">63</a>  <em>     *</em>
<a name="64" href="#64">64</a>  <em>     * @param path String to set for {@link #path}</em>
<a name="65" href="#65">65</a>  <em>     */</em>
<a name="66" href="#66">66</a>      <strong>public</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a>(<strong>final</strong> String path) {
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>          setPath(path);
<a name="69" href="#69">69</a>      }
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>      <em>/**<em>*</em></em>
<a name="73" href="#73">73</a>  <em>     * &lt;p>Getter for property {@link #path}.&lt;/p></em>
<a name="74" href="#74">74</a>  <em>     *</em>
<a name="75" href="#75">75</a>  <em>     * @return Value for property &lt;tt>path&lt;/tt>.</em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>public</strong> String getPath() {
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>          <strong>return</strong> path;
<a name="80" href="#80">80</a>      }
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>     * &lt;p>Setter for property  {@link #path}&lt;/p></em>
<a name="85" href="#85">85</a>  <em>     *</em>
<a name="86" href="#86">86</a>  <em>     * @param path Value to set for property &lt;tt>path&lt;/tt></em>
<a name="87" href="#87">87</a>  <em>     */</em>
<a name="88" href="#88">88</a>      <strong>public</strong> <strong>void</strong> setPath(<strong>final</strong> String path) {
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>          <strong>this</strong>.path = path;
<a name="91" href="#91">91</a>      }
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <strong>public</strong> <strong>boolean</strong> equals(<strong>final</strong> Object o) {
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>          <strong>if</strong> (<strong>this</strong> == o)
<a name="97" href="#97">97</a>              <strong>return</strong> <strong>true</strong>;
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>          <strong>if</strong> (!(o instanceof JPackage))
<a name="100" href="#100">100</a>             <strong>return</strong> false;
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>         <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a> that = (JPackage) o;
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>         <strong>if</strong> (path != <strong>null</strong>
<a name="105" href="#105">105</a>                 ? !path.equals(that.getPath())
<a name="106" href="#106">106</a>                 : that.getPath() != <strong>null</strong>) {
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>             <strong>return</strong> false;
<a name="109" href="#109">109</a>         }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>         <strong>return</strong> <strong>true</strong>;
<a name="112" href="#112">112</a>     }
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <strong>public</strong> <strong>int</strong> hashCode() {
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>         <strong>return</strong> (path != <strong>null</strong> ? path.hashCode() : 0);
<a name="118" href="#118">118</a>     }
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em>/**<em>*</em></em>
<a name="122" href="#122">122</a> <em>     * @see Object#toString()</em>
<a name="123" href="#123">123</a> <em>     */</em>
<a name="124" href="#124">124</a>     <strong>public</strong> String toString() {
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>         <strong>return</strong> <strong>this</strong>.path;
<a name="127" href="#127">127</a>     }
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>     <em>/**<em>*</em></em>
<a name="131" href="#131">131</a> <em>     * &lt;p>Determines if a given &lt;code>JPackage&lt;/code> or &lt;code>String&lt;/code> is</em>
<a name="132" href="#132">132</a> <em>     * represented by this &lt;code>JPackage&lt;/code>.&lt;/p></em>
<a name="133" href="#133">133</a> <em>     *</em>
<a name="134" href="#134">134</a> <em>     * &lt;p>If given Object is empty String then &lt;tt>false&lt;tt>&lt;&lt;/p></em>
<a name="135" href="#135">135</a> <em>     *</em>
<a name="136" href="#136">136</a> <em>     * @param that a String or JPackage</em>
<a name="137" href="#137">137</a> <em>     * @return boolean &lt;tt>true&lt;/tt> when a perfect match is found or when the</em>
<a name="138" href="#138">138</a> <em>     *         wildcards match.</em>
<a name="139" href="#139">139</a> <em>     */</em>
<a name="140" href="#140">140</a>     <strong>public</strong> <strong>boolean</strong> matches(<strong>final</strong> Object that) {
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>         <strong>if</strong> (!(that instanceof String)
<a name="143" href="#143">143</a>                 &amp;&amp; !(that instanceof <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a>)) {
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>             <strong>return</strong> false;
<a name="146" href="#146">146</a>         }
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>         <strong>if</strong> (that.equals(<span class="string">""</span>))
<a name="149" href="#149">149</a>             <strong>return</strong> false;
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>         <strong>if</strong> (hasWildcards()) {
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>             <strong>return</strong> regExMatch(that);
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>         } <strong>else</strong> {
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>             <strong>return</strong> prefectMatch(that);
<a name="159" href="#159">159</a>         }
<a name="160" href="#160">160</a>     }
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em>/**<em>*</em></em>
<a name="164" href="#164">164</a> <em>     * &lt;p>Determines if this &lt;code>JPackage&lt;/code> uses wildcards to match more</em>
<a name="165" href="#165">165</a> <em>     * than one package.&lt;/p></em>
<a name="166" href="#166">166</a> <em>     *</em>
<a name="167" href="#167">167</a> <em>     * @return boolean &lt;tt>true&lt;/tt> when &lt;tt>path&lt;/tt> contains any of the</em>
<a name="168" href="#168">168</a> <em>     *         {@link #WILDCHARS}.</em>
<a name="169" href="#169">169</a> <em>     */</em>
<a name="170" href="#170">170</a>     <strong>private</strong> <strong>boolean</strong> hasWildcards() {
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>         <strong>for</strong> (<strong>final</strong> <strong>char</strong> wildChar : WILDCHARS)
<a name="173" href="#173">173</a>             <strong>if</strong> (<strong>this</strong>.path.contains(String.valueOf(wildChar)))
<a name="174" href="#174">174</a>                 <strong>return</strong> <strong>true</strong>;
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>         <strong>return</strong> false;
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a> 
<a name="180" href="#180">180</a>     <em>/**<em>*</em></em>
<a name="181" href="#181">181</a> <em>     * &lt;p>Manipulates the &lt;tt>path&lt;/tt> value to add Regular Expression support</em>
<a name="182" href="#182">182</a> <em>     * then attempts to match the Reg Ex against the given &lt;tt>Object&lt;/tt>.&lt;/p></em>
<a name="183" href="#183">183</a> <em>     *</em>
<a name="184" href="#184">184</a> <em>     * &lt;p>This supports &lt;dl> &lt;dt>terminating package&lt;/dt> &lt;dd>1.2.*&lt;/dd></em>
<a name="185" href="#185">185</a> <em>     * &lt;dt>terminating package or sub package description&lt;/dt> &lt;dd>1.2..*&lt;/dd></em>
<a name="186" href="#186">186</a> <em>     * &lt;dt>internal package&lt;/dt> &lt;dd>1.*.2&lt;/dd> &lt;dt>internal package or sub</em>
<a name="187" href="#187">187</a> <em>     * package&lt;/dt> &lt;dd>1.*..4&lt;/dd> &lt;dt>internal and terminating&lt;/dt></em>
<a name="188" href="#188">188</a> <em>     * &lt;dd>1.*.3.*&lt;/dd> &lt;dd>1.*.3..*&lt;/dd>&lt;dd>1..*.5.*&lt;/dd> &lt;/dl>&lt;/p></em>
<a name="189" href="#189">189</a> <em>     *</em>
<a name="190" href="#190">190</a> <em>     *</em>
<a name="191" href="#191">191</a> <em>     * &lt;p>TODO: This does not support the single character &lt;tt>*&lt;/tt> yet.&lt;/p></em>
<a name="192" href="#192">192</a> <em>     *</em>
<a name="193" href="#193">193</a> <em>     * @param that &lt;code>Object&lt;/code> of type &lt;code>String&lt;/code> or</em>
<a name="194" href="#194">194</a> <em>     * &lt;code>JPackage&lt;/code></em>
<a name="195" href="#195">195</a> <em>     * @return boolean &lt;tt>true&lt;/tt> when the given &lt;tt>Object&lt;/tt> is a</em>
<a name="196" href="#196">196</a> <em>     *         supported type, and then regular expression that is constructed</em>
<a name="197" href="#197">197</a> <em>     *         matches.</em>
<a name="198" href="#198">198</a> <em>     */</em>
<a name="199" href="#199">199</a>     <strong>private</strong> <strong>boolean</strong> regExMatch(<strong>final</strong> Object that) {
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>         <em>/**<em>*</em></em>
<a name="202" href="#202">202</a> <em>         * TODO: code support for path = "*"</em>
<a name="203" href="#203">203</a> <em>         * TODO: then Update javadoc</em>
<a name="204" href="#204">204</a> <em>         */</em>
<a name="205" href="#205">205</a>         <strong>final</strong> String regex = <strong>this</strong>.path
<a name="206" href="#206">206</a>                 <em class="comment">// foo.bar exactly foo.bar</em>
<a name="207" href="#207">207</a>                 .replaceAll(<span class="string">"&#47;&#47;."</span>, <span class="string">"&#47;&#47;&#47;&#47;."</span>)
<a name="208" href="#208">208</a>                         <em class="comment">// foo.bar.1 or foo.bar.1.2 and so on...</em>
<a name="209" href="#209">209</a>                 .replaceAll(<span class="string">"&#47;&#47;&#47;&#47;.&#47;&#47;&#47;&#47;.&#47;&#47;&#47;&#47;*"</span>, <span class="string">"&#47;&#47;&#47;&#47;.&#47;&#47;[A-Za-z_0-9.]"</span>)
<a name="210" href="#210">210</a>                         <em class="comment">// packages only</em>
<a name="211" href="#211">211</a>                 .replaceAll(<span class="string">"&#47;&#47;.&#47;&#47;*"</span>, <span class="string">"&#47;&#47;.[A-Za-z_0-9]*"</span>);
<a name="212" href="#212">212</a> 
<a name="213" href="#213">213</a>         <strong>final</strong> Pattern pattern = Pattern.compile(regex);
<a name="214" href="#214">214</a>         <strong>final</strong> Matcher matcher;
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>         <strong>final</strong> <strong>boolean</strong> matched;
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>         <strong>if</strong> (that instanceof String) {
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a>             <strong>final</strong> String thatPackage = (String) that;
<a name="221" href="#221">221</a>             matcher = pattern.matcher(thatPackage);
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>             matched = matcher.matches();
<a name="224" href="#224">224</a> 
<a name="225" href="#225">225</a>         } <strong>else</strong> <strong>if</strong> (that instanceof JPackage) {
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>             <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a> thatPackage = (JPackage) that;
<a name="228" href="#228">228</a>             matcher = pattern.matcher(thatPackage.getPath());
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>             matched = matcher.matches();
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a>         } <strong>else</strong> {
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>             matched = false;
<a name="235" href="#235">235</a>         }
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>         <strong>if</strong> (matched)
<a name="238" href="#238">238</a>             log.debug(format(<span class="string">"matched %s to %s"</span>, <strong>this</strong>.path, that));
<a name="239" href="#239">239</a> 
<a name="240" href="#240">240</a>         <strong>return</strong> matched;
<a name="241" href="#241">241</a>     }
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a> 
<a name="244" href="#244">244</a>     <em>/**<em>*</em></em>
<a name="245" href="#245">245</a> <em>     * &lt;p>Matches by String equals against a String or JPackage&lt;/p></em>
<a name="246" href="#246">246</a> <em>     *</em>
<a name="247" href="#247">247</a> <em>     * @param that &lt;code>Object&lt;/code> of type &lt;code>String&lt;/code> or</em>
<a name="248" href="#248">248</a> <em>     * &lt;code>JPackage&lt;/code></em>
<a name="249" href="#249">249</a> <em>     * @return &lt;tt>true&lt;/tt> when the given &lt;tt>Object&lt;/tt> is a supported type,</em>
<a name="250" href="#250">250</a> <em>     *         and an exact match to this &lt;code>JPackage&lt;/code>.</em>
<a name="251" href="#251">251</a> <em>     */</em>
<a name="252" href="#252">252</a>     <strong>private</strong> <strong>boolean</strong> prefectMatch(<strong>final</strong> Object that) {
<a name="253" href="#253">253</a> 
<a name="254" href="#254">254</a>         <strong>if</strong> (that instanceof String) {
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>             <strong>final</strong> String thatPackage = (String) that;
<a name="257" href="#257">257</a>             <strong>return</strong> <strong>this</strong>.path.equals(thatPackage);
<a name="258" href="#258">258</a>         }
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>         <strong>if</strong> (that instanceof JPackage) {
<a name="261" href="#261">261</a> 
<a name="262" href="#262">262</a>             <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/domain/JPackage.html">JPackage</a> thatPackage = (JPackage) that;
<a name="263" href="#263">263</a>             <strong>return</strong> <strong>this</strong>.path.equals(thatPackage.getPath());
<a name="264" href="#264">264</a>         }
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>         <strong>return</strong> false;
<a name="267" href="#267">267</a>     }
<a name="268" href="#268">268</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

